Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Platform support #152

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Platform support #152

wants to merge 11 commits into from

Conversation

VJanKraemer
Copy link
Contributor

Subject

Add the platform support info for SIL Kit

Developer checklist (address before review)

  • Changelog.md updated
  • Prepared update for depending repositories
  • Documentation updated (public API changes only)
  • API docstrings updated (public API changes only)
  • Rebase → commit history clean
  • Squash and merge → proper PR title

Copy link
Collaborator

@MariusBgm MariusBgm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some remarks and ideas

README.rst Outdated
Comment on lines 156 to 158
* - No Tier
- Not supported, not known whether SIL Kit even builds for this platform. Anything not in `Tier 1` or `Tier 2`

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* - No Tier
- Not supported, not known whether SIL Kit even builds for this platform. Anything not in `Tier 1` or `Tier 2`

I'd drop the No Tier row. And add a sentence on how we deal with other targets.

README.rst Outdated
Comment on lines 145 to 148
SIL Kit provides 3 targets of plfatform support. A platform hereby is defined by
a architecture-operating compiler ABI triple. An example would be
`x86_64-ubuntu20.04-clang`, which is currently our default target for Linux
builds.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
SIL Kit provides 3 targets of plfatform support. A platform hereby is defined by
a architecture-operating compiler ABI triple. An example would be
`x86_64-ubuntu20.04-clang`, which is currently our default target for Linux
builds.
SIL Kit provides two tiers of platform support:
1. Officially build, continuously tested targets for which we provide binary packages, and
2. Targets for which we have (limited) build support but which are not continuously tested and no packages are provided from us.
A platform hereby is defined by a target triplet, consisting of the CPU architecture, operating system and compiler.
An example would be `x86_64-ubuntu20.04-clang`, which is currently our default target for Linux
packages.
SIL Kit should compile and run on any POSIX platform.
If you have feedback for different targets or platforms please report via the GitHub issues, thanks!
A target may be upgraded to `Tier 1` once we have continuous testing for it in place and we have binary packages available for it.

I'd slightly reword it, and add how we deal with other targets.

README.rst Outdated
Comment on lines 166 to 169
* - x86_64-windows-msvc
- X86 64bit Windows builds with MSVC ABI
* - x86_32-windows-msvc
- X86 32bit Windows builds with MSVC ABI
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if the GNU triple makes sense for windows.
should we rather state the MSVC version and toolset version used?
E.g,
MSVC 19 with toolset 14.1
Or the human readable strings, MSVC 19 targeting VS2017

README.rst Outdated
* - Platform
- Notes
* - x86_64-nto-qnx710
- X86 64bit QNX 7.1 RTOS builds
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably add a comment that we're planning on integrating CI/CT for some targets, like for QNX.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants